overlaylayout: Document minimally
authorMatthias Clasen <mclasen@redhat.com>
Sat, 25 Jul 2020 23:02:33 +0000 (19:02 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Sat, 25 Jul 2020 23:02:33 +0000 (19:02 -0400)
This layout manager is not reusable, but we
still need to make its layout properties show
up in the docs.

gtk/gtkoverlaylayout.c

index 27d099fe810f6019a879016ae1c3f9b82152558e..e861f540164f8a30875d11d37e4a0c32517e9c4b 100644 (file)
 
 #include <graphene-gobject.h>
 
+
+/**
+ * SECTION:gtkoverlaylayout
+ * @Title: GtkOverlayLayout
+ * @Short_description: Layout manager that places widgets as overlays
+ *
+ * GtkOverlayLayout is the layout manager used by #GtkOverlay.
+ * It places widgets as overlays on top of the main child.
+ *
+ * This is not a reusable layout manager, since it expects its widget
+ * to be a #GtkOverlay. It only listed here so that its layout
+ * properties get documented.
+ */
+
 struct _GtkOverlayLayout
 {
   GtkLayoutManager parent_instance;